home *** CD-ROM | disk | FTP | other *** search
/ Programmer Power Tools / Programmer Power Tools.iso / c / xrf.arc / XRF.DOC < prev    next >
Encoding:
Text File  |  1985-02-05  |  3.7 KB  |  123 lines
  1. TITLE
  2.  
  3.     xrf    Cross-Reference Lister for C Programs
  4.  
  5. AUTHOR
  6.  
  7.   Written By:
  8.                Bob Denny
  9.                Creative System Design Co.
  10.                3452 E. Foothill Blvd. << Suite 601 >>
  11.                Pasadena, Ca.  91107
  12.                (213) 355-6836
  13.  
  14.   Modified for MSDOS By:
  15.  
  16.         Mike Cole
  17.         Digital Equipment Co.
  18.         PC Customer Information & Support Centre,
  19.         Jays Close,
  20.         Basingstoke,
  21.         Hampshire  RG22 4DE,
  22.         ENGLAND.        (44) 256-59200
  23. SYNOPSIS
  24.  
  25.     xrf [-options] [-o outfile] [file ...] [file...]
  26.  
  27. DESCRIPTION
  28.  
  29.     xrf prepares a cross-reference listing for C source programs.  The
  30.     following options are defined:
  31.  
  32.     -n    Narrow output (80 columns).  The default is 132 columns.
  33.     -i    Symbol size is 31, else truncated to 8 characters (default).
  34.     -s    Spool output to the default line printer.
  35.     -p    Print C source (with linenumbers)
  36.     -c    Concatanate input files(s). The default is seperate reference
  37.         listings for each file.
  38.  
  39.     -o file    Write output to the named file.  The default is the first input
  40.         file encountered, with a filetype (extension) of ".REF".
  41.  
  42.     [file]  Name(s) of C programs. xrf accepts wild-card file input.
  43.         The '.c' suffix is provided automatically. 
  44.  
  45.  
  46. NOTES
  47.  
  48.   1.  Input files may have wild-card names.
  49.   2.  File Specifications are stated WITHOUT AN EXTENSION. 
  50.       An input extension ".C" is added automatically.
  51.       An output extension ".REF" is added automatically.
  52.   3.  If the -o option is not used, an output filename is constructed
  53.       as "<first_input_file>.xrf".
  54.   4.  Logical names can be used for output, E.G. "-o con" will output direct
  55.       to the console (screen).
  56.   5.  For the spool option to work, the MSDOS "PRINT" command must have 
  57.       been used previously. EG PRINT<c/r> will just establish the
  58.       resident print spooler.
  59.  
  60. HISTORY
  61.  
  62.   Experimental Version         X1.0             5-May-80
  63.   Split off initialization     X1.1             7-May-80
  64.   Prototype.                   Y1.2             9-May-80
  65.   Release.                     V1.3             9-May-80
  66.   Chg. for DECUS OTS. & Cmplr. V1.4             1-Jul-80
  67.   Add support for RT-11        V1.5             3-Jul-80
  68.   Conditionalized spool call    V1.6 MM         9-Jul-80
  69.   Added narrow, outfile, etc.    V1.7 MM        10-Jul-80
  70.   Added multiple infiles    V1.8 MM        22-Jul-80
  71.   Fspool now in the library    V1.9 MM         2-Aug-80
  72.   MSDOS version            V1.10MC        13-Jan-85
  73.  
  74. DIAGNOSTICS
  75.  
  76.     xrf ran out of main memory space.    Trying to get too much.
  77.                         Internal error, get help.
  78.                         Not enough memory space.
  79.     Specified file not found.        Cannot open "file"
  80.                         Cannot open output file "file"
  81.     Parameter error.            Usage ...
  82.  
  83.  
  84. BUGS
  85.  
  86. None known (I hope).
  87.  
  88. CREATING FROM SOURCES
  89.  
  90. To Create DECUSC Cross Referencer using Computer Innovations C Compiler 
  91. version 2.20h a batch file CXRF.BAT has been provided. If you alter sources
  92. afterwards, you can use LXRF.BAT to relink
  93.  
  94. To use, ARCH -m xrf | ARCH -rx xrf
  95.         LCMP \cic\h\ \CIC\LIB\
  96.  
  97. CXRF has two parameters: 1 = path for CIC "stdio.h" file.
  98.                          2 = path for CIC "c86s2s.lib" file (small model only).
  99.  
  100. Messages you should see:-
  101.  
  102.     Create DECUSC Cross Referencer using Computer Innovations C Compiler
  103.     Compiling XRF0 ....
  104.     Compiling XRF1 ....
  105.     Compiling XRF2 ....
  106.     Compiling XRF3 ....
  107.     Compiling XRFD ....
  108.     Compiling XRFR ....
  109.     Compiling SPOOL ...
  110.     linking XRF .......
  111.  
  112. Things that can go wrong:-
  113.  
  114.    1    stdio.h path wrong <%1stdio.h>
  115.     Compile of XRF failed.                Parameter 1 wrong
  116.  
  117.    2    library path wrong <%2c86s2s.lib>
  118.     Compile of XRF failed.                Parameter 2 wrong
  119.  
  120.    3    Compile of XRF failed.                Error in last action.
  121.                             Check source files and
  122.                             compiler version.
  123.